home *** CD-ROM | disk | FTP | other *** search
/ Acorn User: China / Acorn User China CD-ROM (UK) (Disc A) / Acorn User China CD-ROM (UK) (Disc A).bin / HENSA / FILE / TRASHCAN.ARC / !TrashCan_!Help < prev    next >
Encoding:
Text File  |  1993-07-28  |  7.3 KB  |  162 lines
  1. ________________________________________________________________________________
  2.  
  3.         ######                          ##                              MANUAL
  4.           ##                            ##
  5.           ##    ## ##    ####    #####  #####    ####    ####   #####
  6.           ##    ### ##      ##  ##      ##  ##  ##  ##      ##  ##  ##
  7.           ##    ##       #####   ####   ##  ##  ##       #####  ##  ##
  8.           ##    ##      ##  ##      ##  ##  ##  ##  ##  ##  ##  ##  ##
  9.           ##    ##       #####  #####   ##  ##   ####    #####  ##  ##
  10.  
  11.                 Release 1.01 (28-Jul-93)  by Stephen Mansfield
  12. ________________________________________________________________________________
  13.  
  14.  ******* SEE DISCLAIMER IN ReadMe FILE SUPPLIED WITH THIS APPLICATION *********
  15.  ******* Please read the RISC OS 3 User guide to ensure you know what *********
  16.  ******* sort of damage this application can cause if used carelessly *********
  17.  
  18.  
  19. INTRODUCTION
  20. /**********/
  21.  
  22.    Computer Graphical User Interfaces (GUIs) often come with a waste bin/
  23.    trash can/dustbin facility where by the user can delete files safely
  24.    with the knowledge that if they deleted the wrong thing the file can be
  25.    restored by extracting it from the trash can.  The facility offered
  26.    by this application is not limited to files.  Directories and filing
  27.    system images may also be deleted (these so called 'objects' in
  28.    the trash can are also known as 'garbage').
  29.  
  30.    Another reason for having this application running is the ability to
  31.    give the deleting operation (AS PROVIDED BY TRASHCAN) different
  32.    Filer options as supplied to all other operation carried out by the Filer.
  33.    As the author I often require the options Confirm and Verbose to be set
  34.    for deleting things but unset when I set a file's access or type.
  35.    Trashcan lets the user set the Filer options for delete as required.
  36.  
  37.    Since this program was written under RISC OS 3.10, advantage has been
  38.    taken of the multitasking Filer operations present in the OS.  Emptying
  39.    the Trashcan (also known as 'Garbage collection') thus takes place
  40.    in the background.  The deletion of objects dragged to the Trashcan
  41.    from Filer windows also takes place in the background.
  42.  
  43.    The following text describes the operation of Trashcan and how to make
  44.    the best use of it.  The ReadMe file also supplied contains other
  45.    information relevant to this application.
  46.  
  47.  
  48. THE TRASH CAN ICON
  49. /****************/
  50.  
  51.    To delete objects, simply drag them from their directory viewer to the
  52.    Trashcan icon.  The icon may invert for a second to visually indicate a
  53.    delete operation is starting.  The location of this Trashcan icon can be
  54.    one of three different places:
  55.  
  56.       - the left hand side of the icon bar,
  57.       - the right hand side of the icon bar,
  58.       - the backdrop of the desktop.
  59.  
  60.    The easiest and preferred way to move the icon to these positions is to
  61.    actually drag the Trashcan icon (with the Select button) to where you want
  62.    it on the screen.  The Trashcan must be dragged past half way on the
  63.    icon bar to change sides.  Another way to set its location is to use the
  64.    'Options...' dialogue box (see later).
  65.  
  66.    Clicking Adjust on the icon opens up a standard directory viewer onto the
  67.    garbage, from this objects can be restored by 'Moving' the object from
  68.    the window to the desired destination window (See the RISC OS 3.1 User
  69.    Guide on Filer Move operations).  The window displaying the Garbage 
  70.    directory is a normal Filer window so all Filer operations are possible.
  71.  
  72.    The usual icon bar menu can be displayed by clicking the Menu button
  73.    over the Trashcan icon whether the icon is on the icon bar or the backdrop.
  74.  
  75.  
  76. THE ICON BAR MENU
  77. /***************/
  78.  
  79.    This menu has five entries with no sub-menus, most are self explanatory
  80.    such as the Info and Quit entries.  The others are explained below:
  81.  
  82.    Empty
  83.  
  84.    This item is used to delete all objects in the Trashcan that have
  85.    previously been dragged to it.  This entry is only of real use
  86.    when the operating mode of Trashcan is to retain deleted files.
  87.    When selected a window will appear to confirm the action. If Shift
  88.    is held down when the Empty menu entry is selected this query window
  89.    will not be displayed (handy for experienced users!).
  90.  
  91.    When the Trashcan becomes too full and files can not be deleted any
  92.    more, you can empty the Trashcan and continue.  Note the emptying
  93.    operation is multitasking and may take some time to complete.  To 
  94.    prevent confusing the Filer, this menu entry is greyed-out when
  95.    emptying is in progress.
  96.  
  97.    Garbage
  98.  
  99.    Although the menu entry's name is a little obscure at first, this
  100.    entry is used to bring up on the desktop the Filer directory viewer of
  101.    Trashcan's Garbage directory.  This window should be used to restore
  102.    deleted files by *moving* the objects from it to another Filer
  103.    directory viewer, although all Filer operations are possible on garbage.
  104.  
  105.    Options...
  106.  
  107.    This item brings up the Options dialogue box to allow Trashcan's
  108.    options to be changed and saved if desired for future instantiations
  109.    (see later for explanation).
  110.  
  111.  
  112. TRASHCAN OPTIONS WINDOW
  113. /*********************/
  114.  
  115.    To cancel this window simply click on the Close window icon in the window's
  116.    border.  To set the options as shown in the window, click on the action
  117.    icon OK.  To set AND save the options click on the save action icon.
  118.    There are four options in the program and are described below.
  119.  
  120. Mode
  121. ~~~~
  122.    Currently the application has two modes of operation:
  123.  
  124.       1) Delete objects permanently, this is equivalent to a Filer delete
  125.       operation.  When objects are dragged to the Trashcan in this mode the
  126.       files are deleted completely and CAN'T be recovered by Trashcan;
  127.  
  128.       2) Retain objects as garbage, Trashcan in this mode will perform a Filer
  129.       move operation, effectively deleting it from its home but at the same
  130.       time storing it in Trashcan's Garbage directory incase it needs to be
  131.       recovered at a later date.
  132.  
  133.    TIP: If objects are to be retained, to reduce disc activity it would
  134.    be wise to install Trashcan on the same disk unit and in the same filing
  135.    system as the objects that are to be deleted.
  136.  
  137. Garbage lifetime
  138. ~~~~~~~~~~~~~~~~
  139.    These options are only relevant when the 'Retain objects as garbage'
  140.    option is set.  With the 'Keep garbage forever' option set, the Garbage
  141.    directory is only emptied when the user initiates it, ie from the menu
  142.    entry.  The other option - 'Delete garbage on shutdown' will delete
  143.    garbage objects in the Trashcan when the user closes down their system
  144.    by pressing Ctrl-Shift-F12 or by selecting the Task Managers shutdown
  145.    feature with Trashcan running.
  146.  
  147. Delete options
  148. ~~~~~~~~~~~~~~
  149.    These options are exactly the same as the Filer options as shown in
  150.    its menu from directory viewers.  See the RISC OS 3 User Guide for an
  151.    explanation.
  152.  
  153. Icon location
  154. ~~~~~~~~~~~~~
  155.    This sets the location of where the Trashcan icon is placed and is
  156.    fairly self explanatory.  If the icon is on the icon bar and the Backdrop
  157.    option is set the Trashcan moves to a default position of the
  158.    bottom right hand corner of the backdrop.  To gain better positioning
  159.    of the Trashcan and allow any position on the backdrop to be saved,
  160.    drag the icon into position and THEN bring up the options dialogue
  161.    box to save the Trashcan state.
  162.